docs(self-hosted): introduce troubleshooting snuba page#17782
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
sfanahata
added a commit
that referenced
this pull request
Jun 23, 2026
## Summary The `crate-ci/typos` checker splits `INSERTs` and `SELECTs` into stems `INSER` and `SELEC`, then flags them as misspellings of `INSERT` and `SELECT`. These are valid pluralized SQL keywords used in technical documentation (e.g., "ClickHouse INSERTs"). This adds both words to the `[default.extend-words]` allowlist in `_typos.toml`, following the same pattern already used for `DSNs`, `SDKs`, `APIs`, etc. ## Motivation Unblocks #17782, which is blocked by the required `Check Typos` CI check due to these false positives on line 89 of `develop-docs/self-hosted/troubleshooting/snuba.mdx`. Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
sfanahata
added a commit
that referenced
this pull request
Jun 23, 2026
## Summary Follow-up to #18520. The full-word entries `INSERTs`/`SELECTs` added in that PR are not sufficient because `crate-ci/typos` splits mixed-case plurals at the case boundary (`INSER` + `Ts`) and checks each subword independently. The stems `INSER` and `SELEC` must also be allowlisted. This follows the same pattern already used in the config: - `STARTD` — stem of `MIGRATED_GETTING_STARTD_DOCS` - `ERRO` — stem of `ERRORs` ## Motivation Unblocks #17782, which is still blocked by the `Check Typos` CI check after #18520 was merged. Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
- Change sidebar_order from 2 to 6 to avoid conflict with kafka.mdx (existing pages use orders 1-5) - Fix subject-verb agreement: 'ingest' -> 'ingests' - Fix spelling: 'queryer' -> 'querier' - Fix phrasing: 'returns the results into' -> 'returns the results to' - Remove double space before backtick-quoted text
The Kafka CLI commands (kafka-console-consumer, kafka-consumer-groups) need to run inside the Kafka container in the self-hosted Docker Compose environment. Add 'docker compose exec kafka' prefix and '--bootstrap-server kafka:9092' flag to match the pattern used in kafka.mdx. Also normalize 'kafka-consumer-groups.sh' to 'kafka-consumer-groups' (no .sh suffix) for consistency.
The kafka-consumer-groups --describe command requires either --group or --all-groups to be specified. Add --all-groups since this is a general troubleshooting hint.
The actual consumer group used by snuba-subscription-consumer-events in docker-compose.yml is 'snuba-events-subscriptions-consumers', not 'snuba-events-subscription-executor'.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes getsentry/self-hosted#4157
Most self-hosted users most likely won't read Snuba's documentation (https://getsentry.github.io/snuba/) and it mostly only includes technical stuff related to ClickHouse, but not the thoughts behind them.